'\"
'\" Generated from file 'trig\&.man' by tcllib/doctools with format 'nroff'
'\" Copyright (c) 2018 Arjen Markus
'\"
.TH "math::trig" n 1\&.0\&.0 tcllib "Tcl Math Library"
.\" The -*- nroff -*- definitions below are for supplemental macros used
.\" in Tcl/Tk manual entries.
.\"
.\" .AP type name in/out ?indent?
.\"	Start paragraph describing an argument to a library procedure.
.\"	type is type of argument (int, etc.), in/out is either "in", "out",
.\"	or "in/out" to describe whether procedure reads or modifies arg,
.\"	and indent is equivalent to second arg of .IP (shouldn't ever be
.\"	needed;  use .AS below instead)
.\"
.\" .AS ?type? ?name?
.\"	Give maximum sizes of arguments for setting tab stops.  Type and
.\"	name are examples of largest possible arguments that will be passed
.\"	to .AP later.  If args are omitted, default tab stops are used.
.\"
.\" .BS
.\"	Start box enclosure.  From here until next .BE, everything will be
.\"	enclosed in one large box.
.\"
.\" .BE
.\"	End of box enclosure.
.\"
.\" .CS
.\"	Begin code excerpt.
.\"
.\" .CE
.\"	End code excerpt.
.\"
.\" .VS ?version? ?br?
.\"	Begin vertical sidebar, for use in marking newly-changed parts
.\"	of man pages.  The first argument is ignored and used for recording
.\"	the version when the .VS was added, so that the sidebars can be
.\"	found and removed when they reach a certain age.  If another argument
.\"	is present, then a line break is forced before starting the sidebar.
.\"
.\" .VE
.\"	End of vertical sidebar.
.\"
.\" .DS
.\"	Begin an indented unfilled display.
.\"
.\" .DE
.\"	End of indented unfilled display.
.\"
.\" .SO ?manpage?
.\"	Start of list of standard options for a Tk widget. The manpage
.\"	argument defines where to look up the standard options; if
.\"	omitted, defaults to "options". The options follow on successive
.\"	lines, in three columns separated by tabs.
.\"
.\" .SE
.\"	End of list of standard options for a Tk widget.
.\"
.\" .OP cmdName dbName dbClass
.\"	Start of description of a specific option.  cmdName gives the
.\"	option's name as specified in the class command, dbName gives
.\"	the option's name in the option database, and dbClass gives
.\"	the option's class in the option database.
.\"
.\" .UL arg1 arg2
.\"	Print arg1 underlined, then print arg2 normally.
.\"
.\" .QW arg1 ?arg2?
.\"	Print arg1 in quotes, then arg2 normally (for trailing punctuation).
.\"
.\" .PQ arg1 ?arg2?
.\"	Print an open parenthesis, arg1 in quotes, then arg2 normally
.\"	(for trailing punctuation) and then a closing parenthesis.
.\"
.\"	# Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
.if t .wh -1.3i ^B
.nr ^l \n(.l
.ad b
.\"	# Start an argument description
.de AP
.ie !"\\$4"" .TP \\$4
.el \{\
.   ie !"\\$2"" .TP \\n()Cu
.   el          .TP 15
.\}
.ta \\n()Au \\n()Bu
.ie !"\\$3"" \{\
\&\\$1 \\fI\\$2\\fP (\\$3)
.\".b
.\}
.el \{\
.br
.ie !"\\$2"" \{\
\&\\$1	\\fI\\$2\\fP
.\}
.el \{\
\&\\fI\\$1\\fP
.\}
.\}
..
.\"	# define tabbing values for .AP
.de AS
.nr )A 10n
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
.nr )B \\n()Au+15n
.\"
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
.nr )C \\n()Bu+\\w'(in/out)'u+2n
..
.AS Tcl_Interp Tcl_CreateInterp in/out
.\"	# BS - start boxed text
.\"	# ^y = starting y location
.\"	# ^b = 1
.de BS
.br
.mk ^y
.nr ^b 1u
.if n .nf
.if n .ti 0
.if n \l'\\n(.lu\(ul'
.if n .fi
..
.\"	# BE - end boxed text (draw box now)
.de BE
.nf
.ti 0
.mk ^t
.ie n \l'\\n(^lu\(ul'
.el \{\
.\"	Draw four-sided box normally, but don't draw top of
.\"	box if the box started on an earlier page.
.ie !\\n(^b-1 \{\
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.el \}\
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.\}
.fi
.br
.nr ^b 0
..
.\"	# VS - start vertical sidebar
.\"	# ^Y = starting y location
.\"	# ^v = 1 (for troff;  for nroff this doesn't matter)
.de VS
.if !"\\$2"" .br
.mk ^Y
.ie n 'mc \s12\(br\s0
.el .nr ^v 1u
..
.\"	# VE - end of vertical sidebar
.de VE
.ie n 'mc
.el \{\
.ev 2
.nf
.ti 0
.mk ^t
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
.sp -1
.fi
.ev
.\}
.nr ^v 0
..
.\"	# Special macro to handle page bottom:  finish off current
.\"	# box/sidebar if in box/sidebar mode, then invoked standard
.\"	# page bottom macro.
.de ^B
.ev 2
'ti 0
'nf
.mk ^t
.if \\n(^b \{\
.\"	Draw three-sided box if this is the box's first page,
.\"	draw two sides but no top otherwise.
.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.\}
.if \\n(^v \{\
.nr ^x \\n(^tu+1v-\\n(^Yu
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
.\}
.bp
'fi
.ev
.if \\n(^b \{\
.mk ^y
.nr ^b 2
.\}
.if \\n(^v \{\
.mk ^Y
.\}
..
.\"	# DS - begin display
.de DS
.RS
.nf
.sp
..
.\"	# DE - end display
.de DE
.fi
.RE
.sp
..
.\"	# SO - start of list of standard options
.de SO
'ie '\\$1'' .ds So \\fBoptions\\fR
'el .ds So \\fB\\$1\\fR
.SH "STANDARD OPTIONS"
.LP
.nf
.ta 5.5c 11c
.ft B
..
.\"	# SE - end of list of standard options
.de SE
.fi
.ft R
.LP
See the \\*(So manual entry for details on the standard options.
..
.\"	# OP - start of full description for a single option
.de OP
.LP
.nf
.ta 4c
Command-Line Name:	\\fB\\$1\\fR
Database Name:	\\fB\\$2\\fR
Database Class:	\\fB\\$3\\fR
.fi
.IP
..
.\"	# CS - begin code excerpt
.de CS
.RS
.nf
.ta .25i .5i .75i 1i
..
.\"	# CE - end code excerpt
.de CE
.fi
.RE
..
.\"	# UL - underline word
.de UL
\\$1\l'|0\(ul'\\$2
..
.\"	# QW - apply quotation marks to word
.de QW
.ie '\\*(lq'"' ``\\$1''\\$2
.\"" fix emacs highlighting
.el \\*(lq\\$1\\*(rq\\$2
..
.\"	# PQ - apply parens and quotation marks to word
.de PQ
.ie '\\*(lq'"' (``\\$1''\\$2)\\$3
.\"" fix emacs highlighting
.el (\\*(lq\\$1\\*(rq\\$2)\\$3
..
.\"	# QR - quoted range
.de QR
.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
.\"" fix emacs highlighting
.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
..
.\"	# MT - "empty" string
.de MT
.QW ""
..
.BS
.SH NAME
math::trig \- Trigonometric anf hyperbolic functions
.SH SYNOPSIS
package require \fBTcl  8\&.5\fR
.sp
package require \fBmath::trig  1\&.0\&.0\fR
.sp
\fB::math::trig::radian_reduced\fR \fIangle\fR
.sp
\fB::math::trig::degree_reduced\fR \fIangle\fR
.sp
\fB::math::trig::cosec\fR \fIangle\fR
.sp
\fB::math::trig::sec\fR \fIangle\fR
.sp
\fB::math::trig::cotan\fR \fIangle\fR
.sp
\fB::math::trig::acosec\fR \fIvalue\fR
.sp
\fB::math::trig::asec\fR \fIvalue\fR
.sp
\fB::math::trig::acotan\fR \fIvalue\fR
.sp
\fB::math::trig::cosech\fR \fIvalue\fR
.sp
\fB::math::trig::sech\fR \fIvalue\fR
.sp
\fB::math::trig::cotanh\fR \fIvalue\fR
.sp
\fB::math::trig::asinh\fR \fIvalue\fR
.sp
\fB::math::trig::acosh\fR \fIvalue\fR
.sp
\fB::math::trig::atanh\fR \fIvalue\fR
.sp
\fB::math::trig::acosech\fR \fIvalue\fR
.sp
\fB::math::trig::asech\fR \fIvalue\fR
.sp
\fB::math::trig::acotanh\fR \fIvalue\fR
.sp
\fB::math::trig::sind\fR \fIangle\fR
.sp
\fB::math::trig::cosd\fR \fIangle\fR
.sp
\fB::math::trig::tand\fR \fIangle\fR
.sp
\fB::math::trig::cosecd\fR \fIangle\fR
.sp
\fB::math::trig::secd\fR \fIangle\fR
.sp
\fB::math::trig::cotand\fR \fIangle\fR
.sp
.BE
.SH DESCRIPTION
.PP
The \fImath::trig\fR package defines a set of trigonomic and hyperbolic functions
and their inverses\&. In addition it defines versions of the trigonomic functions
that take arguments in degrees instead of radians\&.
.PP
For easy use these functions may be imported into the \fItcl::mathfunc\fR namespace,
so that they can be used directly in the \fIexpr\fR command\&.
.SH FUNCTIONS
The functions \fIradian_reduced\fR and \fIdegree_reduced\fR return a reduced angle, in
respectively radians and degrees, in the intervals [0, 2pi) and [0, 360):
.TP
\fB::math::trig::radian_reduced\fR \fIangle\fR
Return the equivalent angle in the interval [0, 2pi)\&.
.RS
.TP
float \fIangle\fR
Angle (in radians)
.RE
.TP
\fB::math::trig::degree_reduced\fR \fIangle\fR
Return the equivalent angle in the interval [0, 360)\&.
.RS
.TP
float \fIangle\fR
Angle (in degrees)
.RE
.PP
The following trigonomic functions are defined in addition to the ones defined
in the \fIexpr\fR command:
.TP
\fB::math::trig::cosec\fR \fIangle\fR
Calculate the cosecant of the angle (1/cos(angle))
.RS
.TP
float \fIangle\fR
Angle (in radians)
.RE
.TP
\fB::math::trig::sec\fR \fIangle\fR
Calculate the secant of the angle (1/sin(angle))
.RS
.TP
float \fIangle\fR
Angle (in radians)
.RE
.TP
\fB::math::trig::cotan\fR \fIangle\fR
Calculate the cotangent of the angle (1/tan(angle))
.RS
.TP
float \fIangle\fR
Angle (in radians)
.RE
.PP
For these functions also the inverses are defined:
.TP
\fB::math::trig::acosec\fR \fIvalue\fR
Calculate the arc cosecant of the value
.RS
.TP
float \fIvalue\fR
Value of the argument
.RE
.TP
\fB::math::trig::asec\fR \fIvalue\fR
Calculate the arc secant of the value
.RS
.TP
float \fIvalue\fR
Value of the argument
.RE
.TP
\fB::math::trig::acotan\fR \fIvalue\fR
Calculate the arc cotangent of the value
.RS
.TP
float \fIvalue\fR
Value of the argument
.RE
.PP
The following hyperbolic and inverse hyperbolic functions are defined:
.TP
\fB::math::trig::cosech\fR \fIvalue\fR
Calculate the hyperbolic cosecant of the value (1/sinh(value))
.RS
.TP
float \fIvalue\fR
Value of the argument
.RE
.TP
\fB::math::trig::sech\fR \fIvalue\fR
Calculate the hyperbolic secant of the value (1/cosh(value))
.RS
.TP
float \fIvalue\fR
Value of the argument
.RE
.TP
\fB::math::trig::cotanh\fR \fIvalue\fR
Calculate the hyperbolic cotangent of the value (1/tanh(value))
.RS
.TP
float \fIvalue\fR
Value of the argument
.RE
.TP
\fB::math::trig::asinh\fR \fIvalue\fR
Calculate the arc hyperbolic sine of the value
.RS
.TP
float \fIvalue\fR
Value of the argument
.RE
.TP
\fB::math::trig::acosh\fR \fIvalue\fR
Calculate the arc hyperbolic cosine of the value
.RS
.TP
float \fIvalue\fR
Value of the argument
.RE
.TP
\fB::math::trig::atanh\fR \fIvalue\fR
Calculate the arc hyperbolic tangent of the value
.RS
.TP
float \fIvalue\fR
Value of the argument
.RE
.TP
\fB::math::trig::acosech\fR \fIvalue\fR
Calculate the arc hyperbolic cosecant of the value
.RS
.TP
float \fIvalue\fR
Value of the argument
.RE
.TP
\fB::math::trig::asech\fR \fIvalue\fR
Calculate the arc hyperbolic secant of the value
.RS
.TP
float \fIvalue\fR
Value of the argument
.RE
.TP
\fB::math::trig::acotanh\fR \fIvalue\fR
Calculate the arc hyperbolic cotangent of the value
.RS
.TP
float \fIvalue\fR
Value of the argument
.RE
.PP
The following versions of the common trigonometric functions and their
inverses are defined:
.TP
\fB::math::trig::sind\fR \fIangle\fR
Calculate the sine of the angle (in degrees)
.RS
.TP
float \fIangle\fR
Angle (in degrees)
.RE
.TP
\fB::math::trig::cosd\fR \fIangle\fR
Calculate the cosine of the angle (in degrees)
.RS
.TP
float \fIangle\fR
Angle (in radians)
.RE
.TP
\fB::math::trig::tand\fR \fIangle\fR
Calculate the cotangent of the angle (in degrees)
.RS
.TP
float \fIangle\fR
Angle (in degrees)
.RE
.TP
\fB::math::trig::cosecd\fR \fIangle\fR
Calculate the cosecant of the angle (in degrees)
.RS
.TP
float \fIangle\fR
Angle (in degrees)
.RE
.TP
\fB::math::trig::secd\fR \fIangle\fR
Calculate the secant of the angle (in degrees)
.RS
.TP
float \fIangle\fR
Angle (in degrees)
.RE
.TP
\fB::math::trig::cotand\fR \fIangle\fR
Calculate the cotangent of the angle (in degrees)
.RS
.TP
float \fIangle\fR
Angle (in degrees)
.RE
.PP
.SH "BUGS, IDEAS, FEEDBACK"
This document, and the package it describes, will undoubtedly contain
bugs and other problems\&.
Please report such in the category \fImath :: trig\fR of the
\fITcllib Trackers\fR [http://core\&.tcl\&.tk/tcllib/reportlist]\&.
Please also report any ideas for enhancements you may have for either
package and/or documentation\&.
.PP
When proposing code changes, please provide \fIunified diffs\fR,
i\&.e the output of \fBdiff -u\fR\&.
.PP
Note further that \fIattachments\fR are strongly preferred over
inlined patches\&. Attachments can be made by going to the \fBEdit\fR
form of the ticket immediately after its creation, and then using the
left-most button in the secondary navigation bar\&.
.SH KEYWORDS
math, trigonometry
.SH CATEGORY
Mathematics
.SH COPYRIGHT
.nf
Copyright (c) 2018 Arjen Markus

.fi
